qacli baseline

以前の解析実行からの診断の抑止を制御します。


使用方法

baseline  {-d <snapshot-name>|--pull-suppressions <snapshot-name>|-l|-b|
       -g} [-P <directory>] [-K <config name>] [-B <OFF|VCS|LOCAL|
       UNIFIED|VALIDATE>] [-U <[protocol://]host[:port]>] [-s 
       <local-source>] [-u <username>] [-p <password>] [-w 
       <password-file>] [-t 
       <token>] [-c] [--] [-h]

詳しい説明

ベースライン診断抑止は、新しい開発サイクルを開始する決定を行う際に、古い診断メッセー ジを抑止するために使用します。

ベースラインを生成すると、その時点の診断を含んだベースラインが表示されます。その後の解析で、診断がベースライン内の診断と同じと識別された場合は抑止されます。

最新の差分方式の技術は、周辺のコードの一部が変化した場合でも、診断を一致させるために使用されます。OFF、VCS、LOCAL、UNIFIED、VALIDATE の適用できる異なるタイプのベースラインがあります(ほとんどの場合、相互排他的)。

これについては、以下の「例」で詳しく述べます。

診断ベースラインと同様、統合 Dashboard プロジェクトからのインタラクティブな抑止のダウンロードおよび、適用もサポートされています。Validate ベースラインはサーバからサイテーションデータも取得し、インタラクティブな抑止として適用します。


オプション

オプション名、短縮形 デフォルト 説明
‑‑baseline‑type, ‑B   実行したいコマンドと対になっているベースラインタイプ(OFF|VCS|LOCAL|UNIFIED|VALIDATE)を選択します。ベースラインタイプは「ベースラインの生成」と「ベースラインの設定」と合わせて使用します。
‑‑config, ‑K   複数の設定を持つプロジェクトに対しどの設定を使用するかを指定します。指定がない場合は、デフォルトが使用されます。
‑‑generate‑baseline, ‑g   Validate、VCS、またはローカルのベースラインを生成します。
‑‑help,‑h   使用方法の情報を表示し、終了します。
‑‑ignore‑rest, ‑‑   このフラグ以降のラベルの付いた引数をすべて無視します。
‑‑list‑snapshots, ‑l   プロジェクトの有効なスナップショットをリストします。プロジェクトは有効な統合プロジェクトでなければなりません。
‑‑local‑cache, ‑c   解析を実行中のValidate サーバからの診断の取得を無効化します。
‑‑local‑source, ‑s   生成されているベースライン抑止のファイルの任意の場所を指定します。ローカルベースラインについては、抑止ファイルが既存している必要があります。
‑‑password, ‑p   Dashboardのパスワードです。Dashboardの認証情報または、パスワードファイルにトークンを使用することを考慮してください。
‑‑password‑file, ‑w   Dashboardのパスワードが含まれているファイルへのパス名です。パスワードは適切に保存、管理されなければなりません。
‑‑pull‑baseline, ‑d   必要なスナップショットを取得します。プロジェクトは有効な統合プロジェクトでなければなりません。
‑‑pull‑suppressions   Dashboardスナップショットから相互抑止を取得します。プロジェクトは有効な統合プロジェクトでなければなりません。
‑‑qaf‑project, ‑P . Perforce QAC プロジェクトへの有効なパスを指定します。
‑‑set‑baseline, ‑b   すでに生成されているベースライン抑止のファイルを使用するために指定します。
‑‑token, ‑t   Dashboard にはユーザクレデンシャルではなく、用意されている認証情報トークンを使用してください。作成の詳細については、qacli auth ‑‑dashboard を参照してください。
‑‑url, ‑U   結果を保管しているサーバの URL。httpプロトコルがデフォルトです。例えば、localhost、127.0.0.1:8080、 https://prometheus:8888 など
‑‑username, ‑u   Dashboardユーザ名です。Dashboardの認証情報にトークンを使用することを考慮してください。

Dashboard ( ‑‑baseline‑type = UNIFIED であるとき)を使用するときは、プロジェクトは統合プロジェクトである必要があります。プロジェクト定義の集中管理を参照してください。

VCS ( ‑‑baseline‑type = VCS であるとき) を使用するときは、VCF ファイルが事前に設定されている必要があります。バージョン管理システム設定を参照してください。

VALIDATE ( ‑‑baseline‑type = VALIDATE)を使用するときは、プロジェクトはValidate結合プロジェクトである必要があります。 qacli validate connect を参照してください。

Dashboard ベースラインの設定と使用

Dashboard ベースラインの設定には、Dashboard のスナップショットからコードと診断をダウンロードすることが含まれます。これが終了したのち、 Perforce QACでベースラインを適用する必要があります。

これらのベースラインは、Dashboard内のプロジェクトとリンクのある、統合プロジェクトでのみ使用できます。

Dashboardからデータを取得するコマンドは、DashboardサーバーのURLと、ログイン情報を使用してDashboardへ接続する必要があります。「Perforce QAC Dashboard認証情報の指定」に説明がありますが、ログインにはユーザ名、パスワードを使用するか、または、トークンを 使用します。

以下の例では、トークンを使った方法を示しています。 統合プロジェクトに使用可能なスナップショットは以下のコマンドで一覧表示できます。

qacli baseline -P <project_path> --list-snapshots –url <[protocol://]host[:port]> --token <tkn> 

ベースラインをダウンロードするには、以下のコマンドを使用します。

qacli baseline -P <project_path> --pull-baseline <snapshot> --url <[protocol://]host[:port]> --token <tkn> 

ベースラインがダウンロードされたら、以下のコマンドを使用し、適用することができます。

qacli baseline -P <project_path> --set-baseline --baseline-type UNIFIED 

ベースラインをオフにするには、以下のコマンドを使用します。

qacli baseline -P <project_path> --set-baseline --baseline-type OFF 

ローカルベースラインの設定と使用

ローカルベースラインを設定するには、解析結果が既に生成されている必要があります。 解析後、ローカルベースラインは以下のコマンドで生成できます。

qacli baseline -P <project_path> --baseline-type LOCAL --generate-baseline 

ベースラインに関連付けられているソースコードは保存されている必要があります。そうすることで、ベースラインが適用されたとき、ベースライン化された診断と最新のコードでの診断とを一致させるため差分形式の技術を使用することができます。

保存するには以下のコマンドを使用します。

qacli baseline -P <project_path> --baseline-type LOCAL --set-baseline [--local-source <output-path>] 
オプションの出力パスは、ソースコード内の相違の詳細を含むディレクトリです。ほとんどのユーザはデフォルト(prqa\configs\<config-name>\output)のパスで用が足りると思われますが、必要があれば変更することもできます。

ベースラインをオフにするには、以下のコマンドを使用します。

qacli baseline -P <project_path> --baseline-type OFF --set-baseline 

VCSベースラインの設定と使用

これには、現在の解析結果からベースラインを生成し、ベースラインを適用することが含まれます。ベースラインを生成するには、以下のコマンドを実行します。

qacli baseline -P <project_path> --generate-baseline --baseline-type VCS 

ベースラインを適用するには、以下のコマンドを使用します。

qacli baseline -P <project_path> --set-baseline --baseline-type VCS

ベースラインをオフにするには、以下のコマンドを使用します。

qacli baseline -P <project_path> --set-baseline --baseline-type OFF 

Dashboard抑止のダウンロード

一般的な Dashboard 抑止の機能については、抑止のダウンロードを参照してください。

Dashboard 抑止は、統合プロジェクト(Dashboard内のプロジェクトへのリンクのあるもの)のみ利用可能です。

抑止は、Dashboard スナップショットからダウンロードされます。 統合プロジェクトに使用可能なスナップショットは以下のコマンドで一覧表示できます。

qacli baseline -P <project_path> --list-snapshots --url <[protocol://]host[:port]> --token <tkn> 

抑止をダウンロードするには、以下のコマンドを使用します。

qacli baseline -P <project_path> --pull-suppressions <snapshot-name> --url <[protocol://]host[:port]> --token <tkn> 

抑止がダウンロードされると、解析結果が表示されるときに、自動的に適用されます。


Validate Baselineの設定と使用

Validateベースラインを設定、使用するためには、まずValidate 結合プロジェクトがなければなりません。設定が完了すると、プロジェクトは解析中に最新の診断を Validate から取得し、キャッシュファイルを生成し、ベースラインに適用します。

Validate のベースラインは以下の単一コマンドで適用することができます。

qacli baseline -P <project_path> --set-baseline --baseline-type VALIDATE

解析が実行されるごとにValidateから最新の診断を取得するビヘイビアを無効化する場合は、まず、キャシュをローカルで生成することができます。

qacli baseline -P <project_path> --generate-baseline --baseline-type VALIDATE --local-source <cache-dir>

ここでの –local-source は、キャシュファイルを生成する場所を指定するオプションのパラメータです。適用例:

qacli baseline -P <project_path> --set-baseline --baseline-type VALIDATE --local-cache

解析中に fetch-latest を使用するとき、キャッシュファイルは常に <project_path>/…/output/  フォルダに生成されます。